home *** CD-ROM | disk | FTP | other *** search
/ PC Gamer (Italian) 45 / PC Gamer IT CD 45 2-2.iso / utility / smdir30 / smdir30.exe / data1.cab / Other_Files / Batch.txt < prev    next >
Encoding:
Text File  |  1999-08-30  |  16.5 KB  |  383 lines
  1. =================================================
  2.      RUNNING SMARTDIR REPORTS IN BATCH MODE
  3. =================================================
  4.  
  5. The "/run" command line switch can be used to generate SmartDir
  6. reports in an unattended manner. This allows you to create
  7. shortcuts that generate regularly run reports in the background
  8. or to use the system scheduler to automatically generate these
  9. reports at regular intervals. For instance, you could have a
  10. Large Files Report run every Monday at 4:00 AM and a Directory
  11. Size Report run every Friday at 8:00 PM. These reports are
  12. written to .txt files that can later be opened in SmartDir or
  13. imported into other applications. Report criteria is specified
  14. via an "ini" file (the supplied Batch.ini file is used as a
  15. template). Complete documentation for "ini" file parameters is
  16. included below.
  17.  
  18. To set up and run a batch report, follow these steps...
  19.  
  20. 1) Make a copy of the Batch.ini file, and give it a descriptive
  21.    name (i.e. WeeklyFL.ini).
  22.  
  23. 2) Open this new .ini file in a text editor (you can use SmartDir
  24.    for this), and specify the report type, report file name, date
  25.    format, and other options for this report type.
  26.  
  27. 3) To run the report, use the following command (assumes that
  28.    SmartDir is installed in the default directory)...
  29.  
  30.    "C:\Program Files\Gavlock Consulting\SmartDir.exe" /run "C:\Program Files\Gavlock Consulting\WeeklyFL.ini"
  31.  
  32.    This can be entered either as the target for a shortcut or
  33.    set up to be run by the system scheduler at a given time.
  34.  
  35. 4) Repeat the above 3 steps for each batch report you wish to run.
  36.    Note that SmartDir can only generate one report at a time, so
  37.    don't schedule more than one report to run at any one time.
  38.  
  39.  
  40. =================
  41. INI FILE SETTINGS
  42. =================
  43.  
  44. [Options]   (Required) Section header.
  45.  
  46. ReportType= (Required) Two letters specifying the type of report to be generated.
  47.                        Defaults to FL if not specified correctly.
  48.             FL = File Listing
  49.             DS = Directory Size Report
  50.             LF = Large Files Report
  51.             DC = Deletion Candidates Report
  52.  
  53. ReportFile= (Required) The full path name for the .txt output file (in quotes).
  54.                        If a file with this name already exists, it will be overwritten.
  55.             (example) "C:\My Documents\WeeklyFL.txt"
  56.  
  57. DateFormat= (Required) Three letters specifying the date format to be used.
  58.             MDY = MM/DD/YYYY (Default)
  59.             DMY = DD/MM/YYYY
  60.             YMD = YYYY/MM/DD
  61.  
  62. ; File Listing Options (Used if ReportType=FL)
  63. ----------------------------------------------
  64.  
  65. FLBaseDirectory=       The full path name to the base directory for this report (in quotes).
  66.                        Defaults to "C:\" if not specified.
  67.             (examples) "C:\My Documents"
  68.                        "D:\"
  69.  
  70. FLFileType=            The type of files to search for. Entered as a description followed by a
  71.                        file extension spec (in quotes). The file extension spec must be in the
  72.                        format: (*.xxx), where xxx is the file type to be searched for.
  73.                        Defaults to "All files (*.*)" if not specified.
  74.             (examples) "Document files (*.doc)"
  75.                        "GIF files (*.gif)"
  76.  
  77. FLReportFormat=        One letter specifying the desired format for this report.
  78.             R = Regular (Default)
  79.             T = Tab-Delimited
  80.  
  81. FLShowHidden=          Whether or not to show hidden files in the report.
  82.             Yes = Show hidden files
  83.             No  = Don't show hidden files (Default)
  84.  
  85. FLShowSystem=          Whether or not to show system files in the report.
  86.             Yes = Show system files
  87.             No  = Don't show system files (Default)
  88.  
  89. FLShowSubdirectories=  Whether or not to show subdirectories in the report.
  90.             Yes = Show subdirectories
  91.             No  = Don't show subdirectories (Default)
  92.  
  93. FLIncludeSubdirectories=  Whether or not to include subdirectories in the search.
  94.             Yes = Search the base directory and all of its subdirectories
  95.             No  = Search only the base directory (Default)
  96.  
  97. FLOutputName=          Whether or not to show file names in the report.
  98.             Yes = Show file names (Default)
  99.             No  = Don't show file names
  100.  
  101. FLOutputDateModified=  Whether or not to show file last modified dates in the report.
  102.             Yes = Show last modified dates (Default)
  103.             No  = Don't show last modified dates
  104.  
  105. FLOutputSize=          Whether or not to show file sizes in the report.
  106.             Yes = Show file sizes (Default)
  107.             No  = Don't show file sizes
  108.  
  109. FLOutputAttributes=    Whether or not to show file attributes in the report.
  110.             Yes = Show file attributes (Default)
  111.             No  = Don't show file attributes
  112.  
  113. FLOutputDateCreated=   Whether or not to show file creation dates in the report.
  114.             Yes = Show file creation dates
  115.             No  = Don't show file creation dates (Default)
  116.  
  117. FLOutputDateAccessed=  Whether or not to show file last accessed dates in the report.
  118.             Yes = Show file last accessed dates
  119.             No  = Don't show file last accessed dates (Default)
  120.  
  121. FLOutputCompressedSize=  Whether or not to show compressed file sizes in the report.
  122.                          Only meaningful for NTFS file systems.
  123.             Yes = Show compressed file sizes
  124.             No  = Don't show compressed file sizes (Default)
  125.  
  126. FLOutputCompressionRatio=  Whether or not to show file compression ratios in the report.
  127.                            Only meaningful for NTFS file systems.
  128.             Yes = Show file compression ratios
  129.             No  = Don't show file compression ratios (Default)
  130.  
  131. FLOutputSequenceNo=    Whether or not to show sequence numbers in the report.
  132.                        Sequentially numbers each detail line.
  133.             Yes = Show sequence numbers
  134.             No  = Don't show sequence numbers (Default)
  135.  
  136. FLSortBy=              One letter specifying how the report should be sorted.
  137.             N = Name (Default)
  138.             T = Type
  139.             M = Modified date
  140.             S = Size
  141.             C = Creation date
  142.             A = Accessed date
  143.             X = Not sorted
  144.  
  145. FLSortOrder=           One letter specifying the sort order.
  146.             A = Ascending (Default)
  147.             D = Descending
  148.  
  149. ; Directory Size Report Options (Used if ReportType=DS)
  150. -------------------------------------------------------
  151.  
  152. DSBaseDirectory=       The full path name to the base directory for this report (in quotes).
  153.                        Defaults to "C:\" if not specified.
  154.             (examples) "C:\My Documents"
  155.                        "D:\"
  156.  
  157. DSReportType=          One letter specifying the desired report type.
  158.             S = Summary - high-level directories only (Default)
  159.             D = Detailed - includes all subdirectories
  160.  
  161. DSReportFormat=        One letter specifying the desired format for this report.
  162.             R = Regular (Default)
  163.             T = Tab-Delimited
  164.  
  165. DSOutputName=          Whether or not to show directory names in the report.
  166.             Yes = Show directory names (Default)
  167.             No  = Don't show directory names
  168.  
  169. DSOutputFileCount=     Whether or not to show file counts in the report.
  170.             Yes = Show file counts (Default)
  171.             No  = Don't show file counts
  172.  
  173. DSOutputSize=          Whether or not to show directory sizes in the report.
  174.             Yes = Show directory sizes (Default)
  175.             No  = Don't show directory sizes
  176.  
  177. DSOutputDateCreated=   Whether or not to show directory creation dates in the report.
  178.             Yes = Show creation dates
  179.             No  = Don't show creation dates (Default)
  180.  
  181. DSOutputDateModified=  Whether or not to show directory last modified dates in the report.
  182.             Yes = Show last modified dates
  183.             No  = Don't show last modified dates (Default)
  184.  
  185. DSOutputDateAccessed=  Whether or not to show directory last accessed dates in the report.
  186.             Yes = Show last accessed dates
  187.             No  = Don't show last accessed dates (Default)
  188.  
  189. DSOutputCompressedSize=  Whether or not to show compressed directory sizes in the report.
  190.                          Only meaningful for NTFS file systems.
  191.             Yes = Show compressed directory sizes
  192.             No  = Don't show compressed directory sizes (Default)
  193.  
  194. DSOutputCompressionRatio=  Whether or not to show directory compression ratios in the report.
  195.                            Only meaningful for NTFS file systems.
  196.             Yes = Show directory compression ratios
  197.             No  = Don't show directory compression ratios (Default)
  198.  
  199. DSOutputSequenceNo=    Whether or not to show sequence numbers in the report.
  200.                        Sequentially numbers each detail line.
  201.             Yes = Show sequence numbers
  202.             No  = Don't show sequence numbers (Default)
  203.  
  204. DSSortBy=              One letter specifying how the report should be sorted.
  205.             N = Name (Default)
  206.             X = Not sorted
  207.  
  208. ; Large Files Report Options (Used if ReportType=LF)
  209. ----------------------------------------------------
  210.  
  211. LFBaseDirectory=       The full path name to the base directory for this report (in quotes).
  212.                        Defaults to "C:\" if not specified.
  213.             (examples) "C:\My Documents"
  214.                        "D:\"
  215.  
  216. LFFileSize=            The minimum size (in bytes) of files to search for. Entered as a number
  217.                        between 0 and 999,999,999. Commas are allowed, but spaces are not.
  218.                        Defaults to 5,000,000 if not specified correctly.
  219.             (examples) 10,000,000
  220.                        6000000
  221.  
  222. LFReportFormat=        One letter specifying the desired format for this report.
  223.             R = Regular (Default)
  224.             T = Tab-Delimited
  225.  
  226. LFShowHidden=          Whether or not to show hidden files in the report.
  227.             Yes = Show hidden files
  228.             No  = Don't show hidden files (Default)
  229.  
  230. LFShowSystem=          Whether or not to show system files in the report.
  231.             Yes = Show system files
  232.             No  = Don't show system files (Default)
  233.  
  234. LFIncludeSubdirectories=  Whether or not to include subdirectories in the search.
  235.             Yes = Search the base directory and all of its subdirectories (Default)
  236.             No  = Search only the base directory
  237.  
  238. LFOutputName=          Whether or not to show file names in the report.
  239.             Yes = Show file names (Default)
  240.             No  = Don't show file names
  241.  
  242. LFOutputDateModified=  Whether or not to show file last modified dates in the report.
  243.             Yes = Show last modified dates (Default)
  244.             No  = Don't show last modified dates
  245.  
  246. LFOutputSize=          Whether or not to show file sizes in the report.
  247.             Yes = Show file sizes (Default)
  248.             No  = Don't show file sizes
  249.  
  250. LFOutputAttributes=    Whether or not to show file attributes in the report.
  251.             Yes = Show file attributes (Default)
  252.             No  = Don't show file attributes
  253.  
  254. LFOutputDateCreated=   Whether or not to show file creation dates in the report.
  255.             Yes = Show file creation dates
  256.             No  = Don't show file creation dates (Default)
  257.  
  258. LFOutputDateAccessed=  Whether or not to show file last accessed dates in the report.
  259.             Yes = Show file last accessed dates
  260.             No  = Don't show file last accessed dates (Default)
  261.  
  262. LFOutputCompressedSize=  Whether or not to show compressed file sizes in the report.
  263.                          Only meaningful for NTFS file systems.
  264.             Yes = Show compressed file sizes
  265.             No  = Don't show compressed file sizes (Default)
  266.  
  267. LFOutputCompressionRatio=  Whether or not to show file compression ratios in the report.
  268.                            Only meaningful for NTFS file systems.
  269.             Yes = Show file compression ratios
  270.             No  = Don't show file compression ratios (Default)
  271.  
  272. LFOutputSequenceNo=    Whether or not to show sequence numbers in the report.
  273.                        Sequentially numbers each detail line.
  274.             Yes = Show sequence numbers
  275.             No  = Don't show sequence numbers (Default)
  276.  
  277. LFSortBy=              One letter specifying how the report should be sorted.
  278.             N = Name (Default)
  279.             T = Type
  280.             M = Modified date
  281.             S = Size
  282.             C = Creation date
  283.             A = Accessed date
  284.             X = Not sorted
  285.  
  286. LFSortOrder=           One letter specifying the sort order.
  287.             A = Ascending (Default)
  288.             D = Descending
  289.  
  290. ; Deletion Candidates Report Options (Used if ReportType=DC)
  291. ------------------------------------------------------------
  292.  
  293. DCBaseDirectory=       The full path name to the base directory for this report (in quotes).
  294.                        Defaults to "C:\" if not specified.
  295.             (examples) "C:\My Documents"
  296.                        "D:\"
  297.  
  298. DCReportFormat=        One letter specifying the desired format for this report.
  299.             R = Regular (Default)
  300.             T = Tab-Delimited
  301.  
  302. DCIncludeSubdirectories=  Whether or not to include subdirectories in the search.
  303.             Yes = Search the base directory and all of its subdirectories (Default)
  304.             No  = Search only the base directory
  305.  
  306. DCOutputName=          Whether or not to show file names in the report.
  307.             Yes = Show file names (Default)
  308.             No  = Don't show file names
  309.  
  310. DCOutputDateModified=  Whether or not to show file last modified dates in the report.
  311.             Yes = Show last modified dates (Default)
  312.             No  = Don't show last modified dates
  313.  
  314. DCOutputSize=          Whether or not to show file sizes in the report.
  315.             Yes = Show file sizes (Default)
  316.             No  = Don't show file sizes
  317.  
  318. DCOutputAttributes=    Whether or not to show file attributes in the report.
  319.             Yes = Show file attributes (Default)
  320.             No  = Don't show file attributes
  321.  
  322. DCOutputDateCreated=   Whether or not to show file creation dates in the report.
  323.             Yes = Show file creation dates
  324.             No  = Don't show file creation dates (Default)
  325.  
  326. DCOutputDateAccessed=  Whether or not to show file last accessed dates in the report.
  327.             Yes = Show file last accessed dates
  328.             No  = Don't show file last accessed dates (Default)
  329.  
  330. DCOutputCompressedSize=  Whether or not to show compressed file sizes in the report.
  331.                          Only meaningful for NTFS file systems.
  332.             Yes = Show compressed file sizes
  333.             No  = Don't show compressed file sizes (Default)
  334.  
  335. DCOutputCompressionRatio=  Whether or not to show file compression ratios in the report.
  336.                            Only meaningful for NTFS file systems.
  337.             Yes = Show file compression ratios
  338.             No  = Don't show file compression ratios (Default)
  339.  
  340. DCOutputSequenceNo=    Whether or not to show sequence numbers in the report.
  341.                        Sequentially numbers each detail line.
  342.             Yes = Show sequence numbers
  343.             No  = Don't show sequence numbers (Default)
  344.  
  345. DCSortBy=              One letter specifying how the report should be sorted.
  346.             N = Name (Default)
  347.             T = Type
  348.             M = Modified date
  349.             S = Size
  350.             C = Creation date
  351.             A = Accessed date
  352.             X = Not sorted
  353.  
  354. DCSortOrder=           One letter specifying the sort order.
  355.             A = Ascending (Default)
  356.             D = Descending
  357.  
  358. DCTmp=                 Whether or not to search for .tmp files.
  359.             Yes = Search for .tmp files (Default)
  360.             No  = Don't search for .tmp files
  361.  
  362. DCTilde=               Whether or not to search for tilde (~) files.
  363.             Yes = Search for tilde files (Default)
  364.             No  = Don't search for tilde files
  365.  
  366. DCGid=                 Whether or not to search for .gid files.
  367.             Yes = Search for .gid files (Default)
  368.             No  = Don't search for .gid files
  369.  
  370. DCFts=                 Whether or not to search for .fts files.
  371.             Yes = Search for .fts files (Default)
  372.             No  = Don't search for .fts files
  373.  
  374. DCBak=                 Whether or not to search for .bak files.
  375.             Yes = Search for .bak files (Default)
  376.             No  = Don't search for .bak files
  377.  
  378. DCZip=                 Whether or not to search for .zip files.
  379.             Yes = Search for .zip files (Default)
  380.             No  = Don't search for .zip files
  381.  
  382. ================== END OF BATCH.TXT ================================
  383.